<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>http::async_write (1 of 3 overloads)</title>
<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../index.html" title="Chapter 1. Boost.Beast">
<link rel="up" href="../boost__beast__http__async_write.html" title="http::async_write">
<link rel="prev" href="../boost__beast__http__async_write.html" title="http::async_write">
<link rel="next" href="overload2.html" title="http::async_write (2 of 3 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../boost__beast__http__async_write.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__async_write.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="beast.ref.boost__beast__http__async_write.overload1"></a><a class="link" href="overload1.html" title="http::async_write (1 of 3 overloads)">http::async_write
        (1 of 3 overloads)</a>
</h5></div></div></div>
<p>
          Write a complete message to a stream asynchronously using a serializer.
        </p>
<h6>
<a name="beast.ref.boost__beast__http__async_write.overload1.h0"></a>
          <span class="phrase"><a name="beast.ref.boost__beast__http__async_write.overload1.synopsis"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__http__async_write.overload1.synopsis">Synopsis</a>
        </h6>
<p>
          Defined in header <code class="literal">&lt;<a href="../../../../../../../boost/beast/http/write.hpp" target="_top">boost/beast/http/write.hpp</a>&gt;</code>
        </p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
    <span class="keyword">class</span> <a href="../../../../../../../doc/html/boost_asio/reference/AsyncWriteStream.html" target="_top"><span class="emphasis"><em>AsyncWriteStream</em></span></a><span class="special">,</span>
    <span class="keyword">bool</span> <span class="identifier">isRequest</span><span class="special">,</span>
    <span class="keyword">class</span> <a class="link" href="../../concepts/Body.html" title="Body"><span class="emphasis"><em>Body</em></span></a><span class="special">,</span>
    <span class="keyword">class</span> <a class="link" href="../../concepts/Fields.html" title="Fields"><span class="emphasis"><em>Fields</em></span></a><span class="special">,</span>
    <span class="keyword">class</span> <a href="../../../../../../../doc/html/boost_asio/reference/WriteHandler.html" target="_top"><span class="emphasis"><em>WriteHandler</em></span></a> <span class="special">=</span> <span class="identifier">net</span><span class="special">::</span><span class="identifier">default_completion_token_t</span><span class="special">&lt;</span>            <span class="identifier">executor_type</span><span class="special">&lt;</span><span class="identifier">AsyncWriteStream</span><span class="special">&gt;&gt;&gt;</span>
<a href="../../../../../../../doc/html/boost_asio/reference/asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type" target="_top"><span class="emphasis"><em>DEDUCED</em></span></a>
<span class="identifier">async_write</span><span class="special">(</span>
    <span class="identifier">AsyncWriteStream</span><span class="special">&amp;</span> <span class="identifier">stream</span><span class="special">,</span>
    <span class="identifier">serializer</span><span class="special">&lt;</span> <span class="identifier">isRequest</span><span class="special">,</span> <span class="identifier">Body</span><span class="special">,</span> <span class="identifier">Fields</span> <span class="special">&gt;&amp;</span> <span class="identifier">sr</span><span class="special">,</span>
    <span class="identifier">WriteHandler</span><span class="special">&amp;&amp;</span> <span class="identifier">handler</span> <span class="special">=</span> <span class="identifier">net</span><span class="special">::</span><span class="identifier">default_completion_token_t</span><span class="special">&lt;</span> <a class="link" href="../boost__beast__executor_type.html" title="executor_type">executor_type</a><span class="special">&lt;</span> <span class="identifier">AsyncWriteStream</span> <span class="special">&gt;&gt;{});</span>
</pre>
<h6>
<a name="beast.ref.boost__beast__http__async_write.overload1.h1"></a>
          <span class="phrase"><a name="beast.ref.boost__beast__http__async_write.overload1.description"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__http__async_write.overload1.description">Description</a>
        </h6>
<p>
          This function is used to write a complete message to a stream asynchronously
          using a caller-provided HTTP/1 serializer. The function call always returns
          immediately. The asynchronous operation will continue until one of the
          following conditions is true:
        </p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
              The function <a class="link" href="../boost__beast__http__serializer/is_done.html" title="http::serializer::is_done"><code class="computeroutput"><span class="identifier">serializer</span><span class="special">::</span><span class="identifier">is_done</span></code></a> returns <code class="computeroutput"><span class="keyword">true</span></code>
            </li>
<li class="listitem">
              An error occurs.
            </li>
</ul></div>
<p>
          This operation is implemented in terms of zero or more calls to the stream's
          <code class="computeroutput"><span class="identifier">async_write_some</span></code> function,
          and is known as a <span class="emphasis"><em>composed operation</em></span>. The program
          must ensure that the stream performs no other writes until this operation
          completes.
        </p>
<h6>
<a name="beast.ref.boost__beast__http__async_write.overload1.h2"></a>
          <span class="phrase"><a name="beast.ref.boost__beast__http__async_write.overload1.parameters"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__http__async_write.overload1.parameters">Parameters</a>
        </h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                  <p>
                    Name
                  </p>
                </th>
<th>
                  <p>
                    Description
                  </p>
                </th>
</tr></thead>
<tbody>
<tr>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">stream</span></code>
                  </p>
                </td>
<td>
                  <p>
                    The stream to which the data is to be written. The type must
                    support the <span class="emphasis"><em>AsyncWriteStream</em></span> concept.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">sr</span></code>
                  </p>
                </td>
<td>
                  <p>
                    The serializer to use. The object must remain valid at least
                    until the handler is called; ownership is not transferred.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">handler</span></code>
                  </p>
                </td>
<td>
                  <p>
                    The completion handler to invoke when the operation completes.
                    The implementation takes ownership of the handler by performing
                    a decay-copy. The equivalent function signature of the handler
                    must be:
                  </p>
<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">(</span>
    <span class="identifier">error_code</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">error</span><span class="special">,</span>        <span class="comment">// result of operation</span>
    <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">bytes_transferred</span>   <span class="comment">// the number of bytes written to the stream</span>
<span class="special">);</span>
</pre>
                  <p>
                    Regardless of whether the asynchronous operation completes immediately
                    or not, the handler will not be invoked from within this function.
                    Invocation of the handler will be performed in a manner equivalent
                    to using <a class="link" href="../boost__beast__http__verb.html" title="http::verb"><code class="computeroutput"><span class="identifier">net</span><span class="special">::</span><span class="identifier">post</span></code></a>.
                  </p>
                </td>
</tr>
</tbody>
</table></div>
<h6>
<a name="beast.ref.boost__beast__http__async_write.overload1.h3"></a>
          <span class="phrase"><a name="beast.ref.boost__beast__http__async_write.overload1.see_also"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__http__async_write.overload1.see_also">See
          Also</a>
        </h6>
<p>
          <a class="link" href="../boost__beast__http__serializer.html" title="http::serializer"><code class="computeroutput"><span class="identifier">serializer</span></code></a>
        </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
      Falco<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../boost__beast__http__async_write.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__async_write.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
